Skip to content
This repository has been archived by the owner on Nov 17, 2023. It is now read-only.

Improve docs for AMP #15455

Merged
merged 1 commit into from
Jul 11, 2019
Merged

Improve docs for AMP #15455

merged 1 commit into from
Jul 11, 2019

Conversation

anirudh2290
Copy link
Member

Description

Improve docs for AMP. Add docs on how to override whitelist .
How to cast params to FP16.

Checklist

Essentials

Please feel free to remove inapplicable items for your PR.

  • The PR title starts with [MXNET-$JIRA_ID], where $JIRA_ID refers to the relevant JIRA issue created (except PRs with tiny changes)
  • Changes are complete (i.e. I finished coding on this PR)
  • All changes have test coverage:
  • Unit tests are added for small changes to verify correctness (e.g. adding a new operator)
  • Nightly tests are added for complicated/long-running ones (e.g. changing distributed kvstore)
  • Build tests will be added for build configuration changes (e.g. adding a new build option with NCCL)
  • Code is well-documented:
  • For user-facing API changes, API doc string has been updated.
  • For new C++ functions in header files, their functionalities and arguments are documented.
  • For new examples, README.md is added to explain the what the example does, the source of the dataset, expected performance on test set and reference to the original paper if applicable
  • Check the API doc at http://mxnet-ci-doc.s3-accelerate.dualstack.amazonaws.com/PR-$PR_ID/$BUILD_ID/index.html
  • To the my best knowledge, examples are either not affected by this change, or have been fixed to be compatible with this change

Changes

  • Feature1, tests, (and when applicable, API doc)
  • Feature2, tests, (and when applicable, API doc)

Comments

  • If this change is a backward incompatible change, why must this change be made.
  • Interesting edge cases to note here

@anirudh2290 anirudh2290 marked this pull request as ready for review July 4, 2019 01:34
@anirudh2290 anirudh2290 requested a review from szha as a code owner July 4, 2019 01:34
@roywei
Copy link
Member

roywei commented Jul 8, 2019

@mxnet-label-bot add [doc, pr-awaiting-review]

@marcoabreu marcoabreu added Doc pr-awaiting-review PR is waiting for code review labels Jul 8, 2019
@ptrendx
Copy link
Member

ptrendx commented Jul 9, 2019

Number of commits seems wrong - you should probably rebase this PR before merging. Otherwise, LGTM.

@anirudh2290 anirudh2290 merged commit 7a83883 into apache:master Jul 11, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Doc pr-awaiting-review PR is waiting for code review
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants